/*
 * Copyright 2014-2024 Real Logic Limited.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.aeron.archive.checksum;

/**
 * An interface representing API to compute a data checksum.
 * <p>
 * <b>Note:</b> Instances should be threadsafe and stateless.
 */
public interface Checksum
{
    /**
     * Computes a checksum based on the contents of a {@code DirectByteBuffer}.
     *
     * @param address of the buffer.
     * @param offset  within the buffer to begin at.
     * @param length  of the data to read.
     * @return computed checksum value.
     */
    int compute(long address, int offset, int length);
}
